Creating Scheduled Maintenance Events

You can create scheduled maintenance events in the Boomi Cloud API Management dashboard. After creating the event, you can apply it to specific endpoints to include in the maintenance. During the maintenance window, API calls to those endpoints will not be routed. If a request is made during this time, a 503 Service Unavailable error message will be returned. The error message returned can be customized using the Error Sets feature. Refer to API Definition Error Sets for more information.

Procedure

1. Navigate to Manage > Scheduled Maintenance page. This opens the Scheduled Maintenance Events page.

2. Click New Scheduled Maintenance Event. This opens the New Scheduled Maintenance Event pop-up window.

3. On the New Scheduled Maintenance Event window, provide the following details:

   1. In Name, enter the name of the scheduled maintenance event.

   2. In Start Time and End Time, select the Calendar icon to choose a date, and then click Select time to choose a time.

      tip

      You can also change a selected date by clicking on the Change date.

   3. Click Save and close or Save and continue.

      • Selecting Save and close opens the Scheduled Maintenance Events page and shows your newly created scheduled maintenance event on this page.

      • Selecting Save and continue opens the Selected Endpoints: name of your scheduled maintenance event page.

Next Steps

You can add or remove endpoints from the maintenance event on the Selected Endpoints: name of your scheduled maintenance event page. This API call will not be directed to the selected endpoints during the maintenance time. To learn more, refer to Managing Endpoints.